package de.roettger_it.jmoviepilot.util;

import java.util.LinkedList;
/**
 * This class contains the result of a movie search.
 * 
 * <p><b>Note:</b> Even if the search didn't return results (total entries equal to zero), 
 * it may have returned suggestions for the next search.</p>
 * 
 * @author Tobias Roettger
 *
 */
public class MovieSearchResult
{
	private Integer total_entries;
	
	private LinkedList<Movie> movies;
	
	private LinkedList<String> suggestions;

	/**
	 * Gets the number of movies that were found by the search.
	 * 
	 * @return the number of found movies
	 */
	public Integer getTotalEntries()
	{
		return total_entries;
	}

	/**
	 * Sets the number of movies that were found by the search.
	 * 
	 * @param totalEntries the number of found movies to set
	 */
	public void setTotalEntries(int totalEntries)
	{
		this.total_entries = totalEntries;
	}

	/**
	 * Gets all movies that were found by the search in a list.
	 * 
	 * @return the list of all found movies, or null if none could have been found
	 */
	public LinkedList<Movie> getMovies()
	{
		return movies;
	}

	/**
	 * Sets the movies that were found by the search.
	 * 
	 * @param movieList the list of all found movies to set
	 */
	public void setMovies(LinkedList<Movie> movieList)
	{
		this.movies = movieList;
	}
	
	/**
	 * Gets all suggestions that were returned by the search in a list.
	 * 
	 * @return the list of all returned suggestions (may be an empty list), or null if movies could have been found
	 */
	public LinkedList<String> getSuggestions()
	{
		return suggestions;
	}

	/**
	 * Sets the suggestions that were returned by the search.
	 * 
	 * @param suggestionList the list of all returned suggestions to set
	 */
	public void setSuggestions(LinkedList<String> suggestionList)
	{
		this.suggestions = suggestionList;
	}
	
	
}
